Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: update structure for Wallet docs #1581

Open
wants to merge 15 commits into
base: main
Choose a base branch
from
Open

Conversation

dschlabach
Copy link
Contributor

@dschlabach dschlabach commented Nov 5, 2024

What changed? Why?
This PR updates the structure for our documentation to make it easier for developers to scan through available props and sub-components.

Adds:

  • Anatomy section
  • API reference section (with props/types table)

Notes to reviewers

How has it been tested?

@github-actions github-actions bot added the documentation Improvements or additions to documentation label Nov 5, 2024
Copy link

vercel bot commented Nov 14, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
onchainkit-coverage ✅ Ready (Inspect) Visit Preview 💬 Add feedback Nov 15, 2024 5:37pm
onchainkit-playground ✅ Ready (Inspect) Visit Preview 💬 Add feedback Nov 15, 2024 5:37pm
onchainkit-routes ✅ Ready (Inspect) Visit Preview 💬 Add feedback Nov 15, 2024 5:37pm

}, ]} />

### ConnectWallet
Handles the wallet connection process. Place child components inside to customize the connect button appearance.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

we need to standardize on what we call the "child components". in other docs we refer to them as subcomponents, and children below references "customized content"

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I am in support of standardizing around the following:

  1. Components that we ship are subcomponents (e.g. ConnectWallet, NFTMedia, etc)
  2. children the user passes in are just children

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In this case though, I'm in favor of removing "Place child components inside...", it feels unnecessary when the children prop is right there in the table.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Development

Successfully merging this pull request may close these issues.

2 participants